Fix stray reference to old autosummary dir #598
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mtreinish
added
documentation
stable-backport-potential
In Qiskit#544 we updated the autosummary directives output directory from 'stubs' to 'apiref' so that the urls of the hosted documentation made more sense. Then a redirect was added to ensure that stale links to stubs were redirected to the new location. However, as part of this migration one autosummary directory was missed causing it to still publish to 'stubs'. With the redirects in place this means that the documentation is not actually reachable anymore. This commit fixes this oversight by fixing the autosummary directory so the documentation is built in the correct location. Fixes Qiskit#594
mtreinish
force-pushed
the
fix-stray-stubs
branch
from
2e0ab31
to
edbb3e3
Compare
mtreinish
changed the title
Pull Request Test Coverage Report for Build 2239421478
💛 - Coveralls |
mergify bot
pushed a commit
that referenced
this pull request
Apr 28, 2022
In #544 we updated the autosummary directives output directory from 'stubs' to 'apiref' so that the urls of the hosted documentation made more sense. Then a redirect was added to ensure that stale links to stubs were redirected to the new location. However, as part of this migration one autosummary directory was missed causing it to still publish to 'stubs'. With the redirects in place this means that the documentation is not actually reachable anymore. This commit fixes this oversight by fixing the autosummary directory so the documentation is built in the correct location. Fixes #594 (cherry picked from commit dee68e5)
mergify bot
added a commit
that referenced
this pull request
Apr 28, 2022
In #544 we updated the autosummary directives output directory from 'stubs' to 'apiref' so that the urls of the hosted documentation made more sense. Then a redirect was added to ensure that stale links to stubs were redirected to the new location. However, as part of this migration one autosummary directory was missed causing it to still publish to 'stubs'. With the redirects in place this means that the documentation is not actually reachable anymore. This commit fixes this oversight by fixing the autosummary directory so the documentation is built in the correct location. Fixes #594 (cherry picked from commit dee68e5) Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #544 we updated the autosummary directives output directory from
'stubs' to 'apiref' so that the urls of the hosted documentation made
more sense. Then a redirect was added to ensure that stale links to
stubs were redirected to the new location. However, as part of this
migration one autosummary directory was missed causing it to still
publish to 'stubs'. With the redirects in place this means that the
documentation is not actually reachable anymore. This commit fixes this
oversight by fixing the autosummary directory so the documentation is
built in the correct location.
Fixes #594